Skip to main content

Encoding a user Alias

This document explains how the agentAlias field is encoded, the purpose of each part, and provides examples to clarify its structure and usage.

Structure of agentAlias​

An agentAlias is encoded using the following structure:

realm:type:alias

Components​

  1. realm

    • Represents the company or organization name.
    • Examples: com.one37id.
    • Default: If not provided, the current agency realm is used.

  2. type

    • Specifies the type of the alias.
    • Enum Values: alias, email, default, phone, etc.
    • Default: If not provided, the type defaults to alias.

  3. alias

    • The actual alias of the agent.
    • This is a unique identifier specific to the agent.

  4. Delimiter

    • The parts are separated by a colon (:).

  5. URL Encoding

    • All parts of the agentAlias must be URL encoded to ensure proper transmission and parsing.

Examples​

Example 1: Fully Specified agentAlias​

com.one37id:email:john%40gmail.com
  • realm: com.one37id (company name)
  • type: email
  • alias: john@gmail.com (URL encoded as john%40gmail.com)

Example 2: Specified realm and type, Custom Alias​

com.company:phone:123456789
  • realm: com.company (company name)
  • type: phone
  • alias: 123456789 (already URL safe, no encoding needed)

Example 3: Default realm and type​

:alias:mycustomalias
  • realm: Defaults to the current agency realm (e.g., com.one37id).
  • type: Defaults to alias.
  • alias: mycustomalias (no additional encoding needed).

Example 4: URL Encoding Special Characters​

com.one37id:email:first%2Elast%40example%2Ecom
  • realm: com.one37id
  • type: email
  • alias: first.last@example.com (URL encoded as first%2Elast%40example%2Ecom)

Example 5: Using Only Alias​

::simplealias
  • realm: Defaults to the current agency realm (e.g., com.one37id).
  • type: Defaults to alias.
  • alias: simplealias.

Notes​

  1. URL Encoding: Ensure all special characters in each part are properly encoded to avoid parsing errors.
  2. Defaults: If any part is omitted, the system automatically fills in the defaults.
  3. Delimiter: The colon (:) is mandatory between the sections.

By following this structure, the agentAlias encoding ensures compatibility and reliability across systems and workflows.

X

Graph View